<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::Blob_receiver Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classipc_1_1transport_1_1Blob__receiver-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::Blob_receiver Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A documentation-only <em>concept</em> defining the behavior of an object capable of reliably/in-order <em>receiving</em> of discrete messages, each containing a binary blob.  
 <a href="classipc_1_1transport_1_1Blob__receiver.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="blob__transport_8hpp_source.html">blob_transport.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ipc::transport::Blob_receiver:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1Blob__receiver__coll__graph.svg" width="550" height="372"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a048fe523a3b315e2930029d8a6d69164"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a048fe523a3b315e2930029d8a6d69164">Blob_receiver</a> ()</td></tr>
<tr class="memdesc:a048fe523a3b315e2930029d8a6d69164"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.  <a href="classipc_1_1transport_1_1Blob__receiver.html#a048fe523a3b315e2930029d8a6d69164">More...</a><br /></td></tr>
<tr class="separator:a048fe523a3b315e2930029d8a6d69164"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a706434a410624185f61c597ce69b6fd1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a706434a410624185f61c597ce69b6fd1">Blob_receiver</a> (<a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">sync_io::Blob_receiver</a> &amp;&amp;sync_io_core_in_peer_state_moved)</td></tr>
<tr class="memdesc:a706434a410624185f61c597ce69b6fd1"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a></code>-core-adopting ctor: Creates a peer object in PEER state by subsuming a <code><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a></code> core in that state.  <a href="classipc_1_1transport_1_1Blob__receiver.html#a706434a410624185f61c597ce69b6fd1">More...</a><br /></td></tr>
<tr class="separator:a706434a410624185f61c597ce69b6fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96225626169e9db0a5044fc833f69742"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a96225626169e9db0a5044fc833f69742">Blob_receiver</a> (<a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:a96225626169e9db0a5044fc833f69742"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1Blob__receiver.html#a96225626169e9db0a5044fc833f69742">More...</a><br /></td></tr>
<tr class="separator:a96225626169e9db0a5044fc833f69742"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27ebca71ff813621a9d621889f940128"><td class="memItemLeft" align="right" valign="top"><a id="a27ebca71ff813621a9d621889f940128" name="a27ebca71ff813621a9d621889f940128"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Blob_receiver</b> (const <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;)=delete</td></tr>
<tr class="memdesc:a27ebca71ff813621a9d621889f940128"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disallow copying. <br /></td></tr>
<tr class="separator:a27ebca71ff813621a9d621889f940128"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd3fa15abea7c11f014163c21c45d120"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#afd3fa15abea7c11f014163c21c45d120">~Blob_receiver</a> ()</td></tr>
<tr class="memdesc:afd3fa15abea7c11f014163c21c45d120"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this peer endpoint which will end the conceptual incoming-direction pipe (in PEER state, and if it is still active) and cancels any pending completion handlers by invoking them ASAP with <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297afe29343445a7bf167cc186a44bd2c6ed" title="Async completion handler is being called prematurely, because underlying object is shutting down,...">error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a>.  <a href="classipc_1_1transport_1_1Blob__receiver.html#afd3fa15abea7c11f014163c21c45d120">More...</a><br /></td></tr>
<tr class="separator:afd3fa15abea7c11f014163c21c45d120"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a677e91ca276fd9bce3becd356d263382"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a677e91ca276fd9bce3becd356d263382">operator=</a> (<a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:a677e91ca276fd9bce3becd356d263382"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1Blob__receiver.html#a677e91ca276fd9bce3becd356d263382">More...</a><br /></td></tr>
<tr class="separator:a677e91ca276fd9bce3becd356d263382"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56f6659bda848cd1d46a9ae261ef4ea0"><td class="memItemLeft" align="right" valign="top"><a id="a56f6659bda848cd1d46a9ae261ef4ea0" name="a56f6659bda848cd1d46a9ae261ef4ea0"></a>
<a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;)=delete</td></tr>
<tr class="memdesc:a56f6659bda848cd1d46a9ae261ef4ea0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disallow copying. <br /></td></tr>
<tr class="separator:a56f6659bda848cd1d46a9ae261ef4ea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a454ed6207aeba777f779260c142603df"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a454ed6207aeba777f779260c142603df">receive_blob_max_size</a> () const</td></tr>
<tr class="memdesc:a454ed6207aeba777f779260c142603df"><td class="mdescLeft">&#160;</td><td class="mdescRight">In PEER state: Returns min <code>target_blob.size()</code> such that (1) <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a8bc6642dbf4b5e3fdee9f3442f2bbe84" title="In PEER state: Asynchronously awaits one discrete message – as sent by the opposing peer via Blob_sen...">async_receive_blob()</a> shall not fail with <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53" title="User called an API with 1 or more arguments against the API spec.">error::Code::S_INVALID_ARGUMENT</a> (only if <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#ade0c7ca248cd56e4f6c79783b5b6461f" title="If false then blob.size() &gt; receive_blob_max_size() in PEER-state async_receive_blob() shall yield no...">S_BLOB_UNDERFLOW_ALLOWED</a> is <code>false</code>; otherwise not relevant), and (2) it shall <em>never</em> fail with <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210" title="User protocol-code mismatch: local user-provided storage cannot fit entire message received from oppo...">error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE</a>.  <a href="classipc_1_1transport_1_1Blob__receiver.html#a454ed6207aeba777f779260c142603df">More...</a><br /></td></tr>
<tr class="separator:a454ed6207aeba777f779260c142603df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bc6642dbf4b5e3fdee9f3442f2bbe84"><td class="memTemplParams" colspan="2">template&lt;typename Task_err_sz &gt; </td></tr>
<tr class="memitem:a8bc6642dbf4b5e3fdee9f3442f2bbe84"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a8bc6642dbf4b5e3fdee9f3442f2bbe84">async_receive_blob</a> (const <a class="el" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a> &amp;target_blob, Task_err_sz &amp;&amp;on_done_func)</td></tr>
<tr class="memdesc:a8bc6642dbf4b5e3fdee9f3442f2bbe84"><td class="mdescLeft">&#160;</td><td class="mdescRight">In PEER state: Asynchronously awaits one discrete message &ndash; as sent by the opposing peer via <a class="el" href="classipc_1_1transport_1_1Blob__sender.html#a776b55ae93e65592b90c3943ca99e948" title="In PEER state: Synchronously, non-blockingly sends one discrete message, reliably and in-order,...">Blob_sender::send_blob()</a> or <code>"Blob_sender::*end_sending()"</code> &ndash; and receives it into the given target locations, reliably and in-order.  <a href="classipc_1_1transport_1_1Blob__receiver.html#a8bc6642dbf4b5e3fdee9f3442f2bbe84">More...</a><br /></td></tr>
<tr class="separator:a8bc6642dbf4b5e3fdee9f3442f2bbe84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5be288e0479a91e352fdea6d54460b22"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a5be288e0479a91e352fdea6d54460b22">idle_timer_run</a> (<a class="el" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout)</td></tr>
<tr class="memdesc:a5be288e0479a91e352fdea6d54460b22"><td class="mdescLeft">&#160;</td><td class="mdescRight">In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is, once at least the specified time has passed since the last received low-level traffic (or this call, whichever most recently occurred), to emit the pipe-hosing error <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aba920b52e9801e4927dd346ad83ce815" title="No messages (optional auto-pings or otherwise) have been received; optionally configured timeout exce...">error::Code::S_RECEIVER_IDLE_TIMEOUT</a>.  <a href="classipc_1_1transport_1_1Blob__receiver.html#a5be288e0479a91e352fdea6d54460b22">More...</a><br /></td></tr>
<tr class="separator:a5be288e0479a91e352fdea6d54460b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a7aea4b173eb9794db27d423f70c2fb33"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a7aea4b173eb9794db27d423f70c2fb33">S_RESOURCE_TYPE_ID</a></td></tr>
<tr class="memdesc:a7aea4b173eb9794db27d423f70c2fb33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared_name relative-folder fragment (no separators) identifying this resource type. Equals <code>_sender</code>'s.  <a href="classipc_1_1transport_1_1Blob__receiver.html#a7aea4b173eb9794db27d423f70c2fb33">More...</a><br /></td></tr>
<tr class="separator:a7aea4b173eb9794db27d423f70c2fb33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade0c7ca248cd56e4f6c79783b5b6461f"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#ade0c7ca248cd56e4f6c79783b5b6461f">S_BLOB_UNDERFLOW_ALLOWED</a> = value</td></tr>
<tr class="memdesc:ade0c7ca248cd56e4f6c79783b5b6461f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If <code>false</code> then <code>blob.size() &gt; <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a454ed6207aeba777f779260c142603df" title="In PEER state: Returns min target_blob.size() such that (1) async_receive_blob() shall not fail with ...">receive_blob_max_size()</a></code> in PEER-state <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a8bc6642dbf4b5e3fdee9f3442f2bbe84" title="In PEER state: Asynchronously awaits one discrete message – as sent by the opposing peer via Blob_sen...">async_receive_blob()</a> shall yield non-pipe-hosing error::Code::INVALID_ARGUMENT, and it shall never yield pipe-hosing <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210" title="User protocol-code mismatch: local user-provided storage cannot fit entire message received from oppo...">error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE</a>; else the latter may occur, while the former shall never occur for that reason.  <a href="classipc_1_1transport_1_1Blob__receiver.html#ade0c7ca248cd56e4f6c79783b5b6461f">More...</a><br /></td></tr>
<tr class="separator:ade0c7ca248cd56e4f6c79783b5b6461f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A documentation-only <em>concept</em> defining the behavior of an object capable of reliably/in-order <em>receiving</em> of discrete messages, each containing a binary blob. </p>
<p >This is paired with the <a class="el" href="classipc_1_1transport_1_1Blob__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">Blob_sender</a> concept which defines sending of such messages.</p>
<p >The concept is exactly identical to <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Native_handle_receiver</a> except that in the latter each message consists of 0-1 native handles and 0-1 binary blobs; whereas here it is always exactly 1 of the latter. More precisely, each message contains 1 binary blob, whose length must be at least 1 byte. You may interpret notes in common-sense fashion; for example <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a454ed6207aeba777f779260c142603df" title="In PEER state: Returns min target_blob.size() such that (1) async_receive_blob() shall not fail with ...">receive_blob_max_size()</a> here corresponds to <code>receive_meta_blob_max_size()</code> there.</p>
<p >Therefore we keep the documentation very light, only pointing out the differences against <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Native_handle_receiver</a> &ndash; which are summarized in the preceding paragraph. All other notes from <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Native_handle_receiver</a> apply here.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Native_handle_receiver</a>, an identical concept with 1 feature (native handle transmission) added. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__transport_8hpp_source.html#l00191">191</a> of file <a class="el" href="blob__transport_8hpp_source.html">blob_transport.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a048fe523a3b315e2930029d8a6d69164" name="a048fe523a3b315e2930029d8a6d69164"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a048fe523a3b315e2930029d8a6d69164">&#9670;&nbsp;</a></span>Blob_receiver() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::Blob_receiver::Blob_receiver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default ctor: Creates a peer object in NULL (neither connected nor connecting) state. </p>
<p >All notes from Native_handle_receiver() default ctor doc header apply. </p>

</div>
</div>
<a id="a706434a410624185f61c597ce69b6fd1" name="a706434a410624185f61c597ce69b6fd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a706434a410624185f61c597ce69b6fd1">&#9670;&nbsp;</a></span>Blob_receiver() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::Blob_receiver::Blob_receiver </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">sync_io::Blob_receiver</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>sync_io_core_in_peer_state_moved</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a></code>-core-adopting ctor: Creates a peer object in PEER state by subsuming a <code><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a></code> core in that state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sync_io_core_in_peer_state_moved</td><td>See <a class="el" href="classipc_1_1transport_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">Native_handle_sender</a> concept. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a96225626169e9db0a5044fc833f69742" name="a96225626169e9db0a5044fc833f69742"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96225626169e9db0a5044fc833f69742">&#9670;&nbsp;</a></span>Blob_receiver() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::Blob_receiver::Blob_receiver </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>Source object. For reasonable uses of <code>src</code> after this ctor returns: see default ctor doc header. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="afd3fa15abea7c11f014163c21c45d120" name="afd3fa15abea7c11f014163c21c45d120"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd3fa15abea7c11f014163c21c45d120">&#9670;&nbsp;</a></span>~Blob_receiver()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::Blob_receiver::~Blob_receiver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroys this peer endpoint which will end the conceptual incoming-direction pipe (in PEER state, and if it is still active) and cancels any pending completion handlers by invoking them ASAP with <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297afe29343445a7bf167cc186a44bd2c6ed" title="Async completion handler is being called prematurely, because underlying object is shutting down,...">error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a>. </p>
<p >All notes from ~Native_handle_receiver() doc header apply. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8bc6642dbf4b5e3fdee9f3442f2bbe84" name="a8bc6642dbf4b5e3fdee9f3442f2bbe84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bc6642dbf4b5e3fdee9f3442f2bbe84">&#9670;&nbsp;</a></span>async_receive_blob()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Task_err_sz &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::Blob_receiver::async_receive_blob </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a> &amp;&#160;</td>
          <td class="paramname"><em>target_blob</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Task_err_sz &amp;&amp;&#160;</td>
          <td class="paramname"><em>on_done_func</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>In PEER state: Asynchronously awaits one discrete message &ndash; as sent by the opposing peer via <a class="el" href="classipc_1_1transport_1_1Blob__sender.html#a776b55ae93e65592b90c3943ca99e948" title="In PEER state: Synchronously, non-blockingly sends one discrete message, reliably and in-order,...">Blob_sender::send_blob()</a> or <code>"Blob_sender::*end_sending()"</code> &ndash; and receives it into the given target locations, reliably and in-order. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html#ae4ac1685f00467a6516f9f24f5d8a280" title="In PEER state: Asynchronously awaits one discrete message – as sent by the opposing peer via Native_h...">Native_handle_receiver::async_receive_native_handle()</a> doc header apply. In particular watch out for the semantics regarding <code>target_blob.size()</code> and potential resulting errors.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Task_err_sz</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">target_blob</td><td><code>target_blob.data()...</code> shall be written to by the time <code>on_done_func()</code> is executed with a falsy code, bytes numbering <code>N</code>, where <code>N</code> is passed to that callback. <code>N</code> shall not exceed <code>target_blob.size()</code>. See above. </td></tr>
    <tr><td class="paramname">on_done_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="a5be288e0479a91e352fdea6d54460b22" name="a5be288e0479a91e352fdea6d54460b22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5be288e0479a91e352fdea6d54460b22">&#9670;&nbsp;</a></span>idle_timer_run()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::Blob_receiver::idle_timer_run </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a>&#160;</td>
          <td class="paramname"><em>timeout</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is, once at least the specified time has passed since the last received low-level traffic (or this call, whichever most recently occurred), to emit the pipe-hosing error <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aba920b52e9801e4927dd346ad83ce815" title="No messages (optional auto-pings or otherwise) have been received; optionally configured timeout exce...">error::Code::S_RECEIVER_IDLE_TIMEOUT</a>. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html#a174ee15818a8bda361bdc40f094faac9" title="In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is,...">Native_handle_receiver::idle_timer_run()</a> doc header apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="a677e91ca276fd9bce3becd356d263382" name="a677e91ca276fd9bce3becd356d263382"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a677e91ca276fd9bce3becd356d263382">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp; ipc::transport::Blob_receiver::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<p >No-op if <code>&amp;src == this</code>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#afd3fa15abea7c11f014163c21c45d120" title="Destroys this peer endpoint which will end the conceptual incoming-direction pipe (in PEER state,...">~Blob_receiver()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>Source object. For reasonable uses of <code>src</code> after this ctor returns: see default ctor doc header. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>*this</code>. </dd></dl>

</div>
</div>
<a id="a454ed6207aeba777f779260c142603df" name="a454ed6207aeba777f779260c142603df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a454ed6207aeba777f779260c142603df">&#9670;&nbsp;</a></span>receive_blob_max_size()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ipc::transport::Blob_receiver::receive_blob_max_size </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>In PEER state: Returns min <code>target_blob.size()</code> such that (1) <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a8bc6642dbf4b5e3fdee9f3442f2bbe84" title="In PEER state: Asynchronously awaits one discrete message – as sent by the opposing peer via Blob_sen...">async_receive_blob()</a> shall not fail with <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53" title="User called an API with 1 or more arguments against the API spec.">error::Code::S_INVALID_ARGUMENT</a> (only if <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#ade0c7ca248cd56e4f6c79783b5b6461f" title="If false then blob.size() &gt; receive_blob_max_size() in PEER-state async_receive_blob() shall yield no...">S_BLOB_UNDERFLOW_ALLOWED</a> is <code>false</code>; otherwise not relevant), and (2) it shall <em>never</em> fail with <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210" title="User protocol-code mismatch: local user-provided storage cannot fit entire message received from oppo...">error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE</a>. </p>
<p >Please see "Blob underflow semantics" (for <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Native_handle_receiver</a>, but applied in common-sense fashion to us) for explanation of these semantics.</p>
<p >Always the same value once in PEER state. The opposing Native_handle_sender::send_blob_max_size() shall return the same value (in the opposing object potentially in a different process).</p>
<p >If <code>*this</code> is not in PEER state (in particular if it is default-cted or moved-from), returns zero; else a positive value.</p>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ade0c7ca248cd56e4f6c79783b5b6461f" name="ade0c7ca248cd56e4f6c79783b5b6461f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade0c7ca248cd56e4f6c79783b5b6461f">&#9670;&nbsp;</a></span>S_BLOB_UNDERFLOW_ALLOWED</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr bool ipc::transport::Blob_receiver::S_BLOB_UNDERFLOW_ALLOWED = value</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>If <code>false</code> then <code>blob.size() &gt; <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a454ed6207aeba777f779260c142603df" title="In PEER state: Returns min target_blob.size() such that (1) async_receive_blob() shall not fail with ...">receive_blob_max_size()</a></code> in PEER-state <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a8bc6642dbf4b5e3fdee9f3442f2bbe84" title="In PEER state: Asynchronously awaits one discrete message – as sent by the opposing peer via Blob_sen...">async_receive_blob()</a> shall yield non-pipe-hosing error::Code::INVALID_ARGUMENT, and it shall never yield pipe-hosing <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210" title="User protocol-code mismatch: local user-provided storage cannot fit entire message received from oppo...">error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE</a>; else the latter may occur, while the former shall never occur for that reason. </p>
<dl class="section see"><dt>See also</dt><dd>"Blob underflow semantics" in <a class="el" href="classipc_1_1transport_1_1Native__handle__sender.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order sending ...">Native_handle_sender</a> concept doc header; they apply equally here. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__transport_8hpp_source.html#l00207">207</a> of file <a class="el" href="blob__transport_8hpp_source.html">blob_transport.hpp</a>.</p>

</div>
</div>
<a id="a7aea4b173eb9794db27d423f70c2fb33" name="a7aea4b173eb9794db27d423f70c2fb33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7aea4b173eb9794db27d423f70c2fb33">&#9670;&nbsp;</a></span>S_RESOURCE_TYPE_ID</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a> ipc::transport::Blob_receiver::S_RESOURCE_TYPE_ID</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Shared_name relative-folder fragment (no separators) identifying this resource type. Equals <code>_sender</code>'s. </p>

<p class="definition">Definition at line <a class="el" href="blob__transport_8hpp_source.html#l00197">197</a> of file <a class="el" href="blob__transport_8hpp_source.html">blob_transport.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>transport/<a class="el" href="blob__transport_8hpp_source.html">blob_transport.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
